Document the release process - #33
Merged
Merged
Conversation
mowi12
force-pushed
the
feat/31-docs-add-release-workflow-documentation
branch
from
March 26, 2026 14:31
5f23afc to
41c751e
Compare
There was a problem hiding this comment.
Pull request overview
Adds release-process documentation to the repository’s GitHub Wiki and updates entry points (wiki sidebar/home + README) so maintainers/users can find it easily.
Changes:
- Adds a new Wiki page documenting the release process and versioning/tagging.
- Adds “Release Process” links to the wiki sidebar, wiki home, and README documentation section.
- Refactors README installation section into clearer “pipx” vs “from source” instructions, and adds a minimal install table to the wiki home.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| wiki/_Sidebar.md | Adds a sidebar link to the new release-process page. |
| wiki/Release-Process.md | Introduces release/versioning documentation and CI release workflow notes. |
| wiki/Home.md | Adds link to release docs and a small installation table pointing back to README. |
| README.md | Clarifies installation instructions and links to the new release-process wiki page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue
Closes #31
Changes
Checklist
Either tick the items or cross out those that do not apply (using
example text) and provide a brief explanation why they do not apply.Author